Webhook KYC Status
Path
- URL: Customer defined path
- Method:
POST - Description: This API is used to receive notifications about the status of the KYC process.
Request
Request Baokim Table
| Params | Data Type + Length | Required | Description |
|---|---|---|---|
| request_id | string(50) | Yes | A unique ID for each request from the customer to Baokim |
| request_time | string(19) | Yes | Time of the request submission.Format: YYYY-MM-DD HH:MM:SS |
| merchant_code | string(20) | Yes | Merchant code provided by Baokim |
| sub_merchant_code | string(20) | Yes | Sub-merchant code. If seller belongs to merchant directly, fill in merchant_code |
| seller_id | string(50) | Yes | Seller ID in merchant system |
| status | string(1) | Yes | 2: KYC passed 3: KYC failed 4: additional documents required |
| reason | string(255) | No | The reason will be available when status = 3 or 4 |
Request Example
{
"request_id": "BK009373788182HUYLLAPU",
"request_time": "2024-11-01 14:00:00",
"merchant_code": "MERCHANT001",
"sub_merchant_code": "MERCHANT001",
"seller_id": "SELLER123456",
"status": "2",
"reason": ""
}
Response
Response Table
| Params | Data type + length | Required | Description |
|---|---|---|---|
| response_code | int(4) | Yes | Error code from Baokim as per Error Codes Table |
| response_message | string(100) | Yes | Description of the error code from Baokim as per Error Codes Table |
Response Example
{
"response_code": 200,
"response_message": "Success"
}
Error Code
| Response Code | Response Message |
|---|---|
| 200 | Success |
| 11 | Failed |
| 101 | System Error |